home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / bbs_game / shuffl33.zip / SHUFFLE.DOC < prev    next >
Text File  |  1996-06-12  |  25KB  |  549 lines

  1.  
  2.                               WORD SHUFFLE
  3.  
  4.                                   v3.3
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.                           Sunrise Door Software
  10.  
  11.                             Sunrise-80  BBS
  12.                         (404) 256-9525 (33.6 USR)
  13.                         (404) 705-9104 (33.6 USR)
  14.                  (404) 256-9518 (Voice, 9am-9:30pm EST)
  15.                     (Email) al_lawre@ix.netcom.com
  16.  
  17.  
  18.  
  19.                                 OVERVIEW
  20.                                 ________
  21.  
  22.  
  23.    Word Shuffle is a word game whereby the computer has scrambled the
  24.    letters of a word and you must unscramble it to make points. The
  25.    game is pretty straight forward and the package also contains a
  26.    program which add new puzzles to the database and as an event, will
  27.    create new puzzles and start a new game, as soon as a pre-determined
  28.    number of players have solved all the puzzles. This is done
  29.    automatically, all you must do is ensure that there are an adequate
  30.    suppply of puzzles in the database. The same program used in the event
  31.    process is the same one you will use to add words to the database.
  32.  
  33.  
  34.  
  35.  
  36.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  37.          created in the directory you run the door from.
  38.  
  39.  
  40.                               INSTALLATION
  41.                               ____________
  42.  
  43.  
  44.    Installation is fairly easy and straight-forward. The following steps and
  45.    examples should have you up and running in a very short period of time.
  46.    It is assumed that you are familiar with setting up DOORS on your system.
  47.    To this end, only examples of the configuration file and Door batch file
  48.    are described.
  49.  
  50.       1) Create a directory to hold all WORD SHUFFLE files.
  51.  
  52.       2) Unzip SHUFFLxx.ZIP into the the above directory.
  53.  
  54.       3) Create a configuration file, with a name of your choice, or
  55.          modify the supplied SHUFFLE.CFG file. A description follows:
  56.  
  57.             **                       Location of System File (See Below)
  58.             SUNRISE-80 BBS           Your BBS Name
  59.             Al                       Sysop's First Name
  60.             Lawrence                 Sysop's Last name
  61.  
  62. |-----------------------------------------------------------------------------|
  63. | READ!     1                        CommPort  \ These 2 lines are required   |
  64. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  65. |-----------------------------------------------------------------------------|
  66.  
  67.             00000000                 Registration Number
  68.  
  69.         #   1                        Number of plays per day/caller (1-3)
  70.                                      (Sysop gets 99 in registerd version ONLY!)
  71.  
  72.         #   2                        Keyboard Timeout Value in Minutes.
  73.  
  74.             50                       Number of entries in the Top Score file
  75.  
  76.         #   NONE                     Full drive:\path\filename for Top Score
  77.                                      Bulletin, or NONE
  78.  
  79.         #   NONE                     Full drive:\path\filename for Top Score
  80.                                      Bulletin (Color), or NONE
  81.  
  82.         #   20                       Number of puzzles comprising the game(QUE)
  83.  
  84.             2                        1 = Do Not Display ADOPT-A-DOOR Message
  85.                                      2 = Display ADOPT-A-DOOR Message
  86.  
  87.             3                        The number of players that must complete
  88.                                      all puzzles, before the puzzles are
  89.                                      changed automatically by SHUFWORD, in
  90.                                      your nightly event processing.
  91.  
  92.     !   #   0                        Time Remaining in Door
  93.                                      (Sysop = Time Remaining - REG. VERSION)
  94.  
  95.         #   Y                        Y = Allow Sysop to have 999 games
  96.                                      N = Do Not Allow Sysop 999 games
  97.  
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.  
  109.     @   #   XXXX/YYYY                 Blackout Range  From/To
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.     @   #   XXXX/YYYY                 Blackout Range  From/To
  112.     @   #   XXXX/YYYY                 Blackout Range  From/To
  113.     @   #   XXXX/YYYY                 Blackout Range  From/To
  114.  
  115.             N                         Y = Force Caller to respond to
  116.                                           Instructions <y/n). May need this with
  117.                                           Digiboards.
  118.                                       N = Allow caller to press ENTER in
  119.                                           response to Instructions <y/N>
  120.  
  121.             N                         Y = Use Alias for Caller's name
  122.                                           (Requires Door.Sys)
  123.                                       N = Use Logon Name for Caller's name
  124.  
  125.  
  126.             Y                         Y = Log all callers to USAGEx
  127.                                       N = Do not log any callers
  128.  
  129.          ** = Replace with ONE of the following:
  130.  
  131. C:\bbs\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  132. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  133. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  134. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  135. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  136. c:\bbs\TRIBBS.SYS               <- Fir TriBBS systems.
  137. C:\BBS\GTUSER.BBS               <- For GT Power
  138.                                    * if using this option you must put the
  139.                                      ComPort # on line 5 and the Node # on
  140.                                      line 6 of the configuration file
  141.  
  142.  
  143.  
  144.          # =  Requires registration to change to a different value
  145.          ! = See "Plays Per DAY/DOOR Time" Below
  146.          @ = See "Blackout Periods" Below
  147.  
  148.  
  149.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  150.  
  151.       4) Create a batch file or modify the DOMINOES file supplied. A
  152.          description of this file follows:
  153.  
  154.             ECHO off
  155.             cd\BBS\DOORS\SHUFFLE      Location of SHUFFLE files
  156.             SHUFFLE SHUFFLE.CFG       EXE filename and CFG filename (Name
  157.                                       used in creating file in #3 above)
  158.             CD\BBS
  159.             BOARD
  160.  
  161.  
  162.        5) When running in more than one node, be sure to supply a
  163.           different configuration name for each node (or see below).
  164.  
  165.        6) If running with Fossil-based multi-port boards add
  166.            /FD to the line containing the CFG name as follows:
  167.  
  168.                        SHUFFLE SHUFFLE.CFG /FD
  169.  
  170.  
  171.  
  172.  
  173.                           TROUBLESHOOTING
  174.                           ---------------
  175.  
  176. (1) If you are running this Door on a 486 system and encounter errors such as
  177.  
  178.     ERROR 6.... OVERFLOW Error
  179.     ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
  180.     KEYBOARD Timeout after 5 minutes
  181.  
  182.     You may have to put the following line in your AUTOEXEC.BAT file:
  183.  
  184.          SET NO87=ON
  185.  
  186. (2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the
  187.     opening screen of the Door, your problem will more than likely be associated
  188.     with the CFG file. The error 62 means that you do not have enough entries
  189.     in the CFG. Compare your CFG file with the CFG definition in the DOC file.
  190.  
  191.  
  192. (3) If you encounter an ERROR 70... Permission Denied, this will more than
  193.     likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that
  194.     comes with your version of DOS. To load it type the word SHARE at the DOS
  195.     prompt. To load it permanently type the word SHARE on a line by itself in
  196.     your AUTOEXEC.BAT file, any place prior to the loading of your BBS
  197.     software. There have been numerous reports that loading SHARE high causes
  198.     some problems, so to be on the safe side, do not load it high.
  199.  
  200.  
  201. Should you have any questions or problem, please do not hesitate to call
  202.    voice for immediate help... 404-256-9518 (9am-9:30pm EST) any day!
  203.  
  204.  
  205.  
  206.                              USAGE LOG
  207.                              ---------
  208.  
  209. As an option, we provide you with the ability to log every player to a text 
  210. file. IF you enter Y in the CFG file to log callers, the Door will place the
  211. caller's name as well as the ON and OFF times each time a caller selects the
  212. Door. A separate file will be created for each Node and the name of the file
  213. will be USAGEx, where x is the Node number.
  214.  
  215. You may delete these files at any time and the Door will recreate them the
  216. next time a caller enters the Door. If you do NOT want to continue logging
  217. callers, change the CFG file entry to N.
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.                           BLACKOUT PERIODS
  225.                           ________________
  226.  
  227.       Use the Blackout ranges option to define up to 5 time periods during
  228.       which you DO NOT want the Door to be played. If a caller tries to access
  229.       the Door during the Blackout period, they will be shown a message that
  230.       contains ALL the Blackout periods you have defined, and to try the Door
  231.       at a later time.
  232.  
  233.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  234.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  235.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  236.  
  237.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  238.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  239.                    a Blackout range.
  240.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  241.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  242.  
  243.  
  244.                           PLAYS Per DAY/DOOR Time
  245.                           _______________________
  246.  
  247.       Plays Per Day and Door Time can be controlled several ways:
  248.  
  249.       (1) You can use the Games Per Day, singular option, in the config
  250.           file above. This option, will affect ALL callers whose Security
  251.           Level is NOT defined in any of the 10 optional Security Level/
  252.           Plays Per Day entries in the config file.
  253.  
  254.       (2) You can use the Door Time, singular option, in the config file
  255.           above. This option, will affect ALL callers whose Security
  256.           Level is NOT defined in any of the 10 optional Security Level/
  257.           Plays Per Day/Door Time entries in the config file.
  258.  
  259.       (3) You can restrict the number of games a specific Security Level
  260.           will be allowed to play per day or REWARD specific Levels with
  261.           more Plays Per Day.
  262.  
  263.           Likewise, you can restrict the Play time for a specific Security
  264.           Level or REWARD specific Levels with more Door Time.
  265.  
  266.           These options are handled by the use of the 10 config
  267.           entries (000=00/00).
  268.  
  269.           The format of each entry is as follows:
  270.  
  271.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  272.                      where =  is a constant and MUST be included
  273.                      where YY is the # of games per day (must be 2 digits)
  274.                      where / is a constant and MUST be included
  275.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  276.  
  277.           If the callers Security Level is NOT defined, his/her Plays Per
  278.           Day and Door Time will be controlled by the values in items
  279.           (1) and (2), above, respectively..
  280.  
  281.           You may define up to 10 Security Levels. All unused entries must
  282.           be defined as   000=00/00
  283.         --------------------------------------------------------------------
  284.           Example: Suppose you had 3 Security Levels defined on your BBS as
  285.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  286.           wanted to set Plays Per Day as :     Subscriber=5
  287.                                            Visiting Sysop=2
  288.                                                   CoSysop=3
  289.                                                    Friend=10
  290.  
  291.           and Door Time as follows:     Subscriber=30 minutes
  292.                                     Visiting Sysop=20 minutes
  293.                                            CoSysop=10 minutes
  294.                                             Friend=remaining call time
  295.  
  296.  
  297.           You would set the Individual "Games per Day" config entry to 1 and
  298.           the individual "Door Time" to 5 minutes (these would be the
  299.           default number of games and default Time for all Security Levels
  300.           other than 20,30 or 40... make them any number you want). Next you
  301.           would replace 4 of the Security Level entries as :  020=05/30
  302.                                                               030=02/20
  303.                                                               040=03/10
  304.                                                               090=10/0
  305.  
  306.  
  307.  
  308.  
  309.                         NON-STANDARD COM SUPPORT
  310.                         ________________________
  311.  
  312.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  313.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  314.       number after the configuration filename. Let's assume your Door is
  315.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  316.       passed to your Door would be:
  317.  
  318.                             FOOBAR FOOBAR.CFG /5
  319.  
  320.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  321.       normally used with COM1. No /x parameter is needed for the standard
  322.       IRQ's.
  323.  
  324.       As an alternative, you may use an environmental variable on the command
  325.       line. To use the variable (following the example above), place a
  326.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  327.       different IRQ number for each node). The command line would now look
  328.       like this:
  329.  
  330.                           FOOBAR FOOBAR.CFG /%IRQ%
  331.  
  332.       This, in combination with the use of the environmental variables
  333.       described in the MULTI-NODE SETUP section will allow you to use one
  334.       batch file and one config file to run this door on all nodes.
  335.  
  336.  
  337.  
  338.  
  339.                            MULTI-NODE SETUP
  340.                            ________________
  341.  
  342.       All Sunrise Doors are Multi-Node capable. Each node must have the
  343.       ability to access a configuration file which will have its own system
  344.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  345.       line. There are 2 ways to accomplish this:
  346.  
  347.       (1) Create a separate configuration file for each node. The only
  348.           difference between each file would be the location of the system
  349.           file for that particular node. For example, on my system there are 2
  350.           nodes and the first line of the config files would look like this:
  351.  
  352.                         NODE1:  H:\PCB1\DOOR.SYS
  353.                         NODE2:  H:\PCB2\DOOR.SYS
  354.  
  355.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  356.  
  357.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  358.           the following PCBoard/Wildcat environmental variables:
  359.  
  360.                  PCBDIR    (Directory containing the System file)
  361.                  PCBDRIVE  (Drive containing the System file)
  362.                  WCNODEID  (Active Node Number)
  363.  
  364.           Thus, the first line of the SINGLE configuration file, for this Door
  365.           would look like this:
  366.  
  367.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  368.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  369.  
  370.       NOTE: This option, as described, assumes that you are running PCB or
  371.             Wildcat software. The environmental variables are automatically
  372.             created by the software for each node.
  373.  
  374.             HOWEVER, if you are running other BBS software you should be able
  375.             to set the variables EXACTLY as described below, for EACH node
  376.             (more than likely in each batch file you use to bring up EACH node):
  377.  
  378.                             PCBDRIVE=C:
  379.                             ^^^^^^^^^
  380.                             PCBDIR=\NODE2
  381.                             ^^^^^^^^
  382.  
  383.             Info with a carat (^) under it, MUST be typed as is. The rest
  384.             depends on your naming conventions.
  385.  
  386.             This, in combination with the use of the optional environmental
  387.             variable described in the NON-STANDARD COM SUPPORT section, will
  388.             allow you to use one batch file and one config file to run this
  389.             door on all nodes.
  390.  
  391.  
  392.  
  393.  
  394.                                 SHUFWORD
  395.                                 ---------
  396.  
  397.     This is the Word Shuffle utility maintenance progam. This program is
  398.     used to add words to the Shuffle database and to perform the nightly
  399.     maintenance.
  400.  
  401.     Note: If running an unregistered copy you will be restricted to 20
  402.           words in the Shuffle database vs 1000 words in the registered
  403.           copy and you will not be able to run as a nightly event.
  404.  
  405.      ********************************************************************
  406.      *                                                                  *
  407.      *   Assuming that your config file is named SHUFFLE.CFG, use the   *
  408.      *   following EXAMPLE to run SHUFWORD to add words to the          *
  409.      *   SHUFFLE database or manually change the current question set.  *
  410.      *                                                                  *
  411.      *                  cd\BBS\doors\shuffle                            *
  412.      *                  SHUFWORD SHUFFLE.CFG                            *
  413.      *                                                                  *
  414.      ********************************************************************
  415.  
  416.  
  417.                              EVENT PROCESSING
  418.                              ________________
  419.  
  420.     After your callers complete all the words you have defined, it becomes
  421.     necessary to change them and start a new game. This task can be done
  422.     manually, using SHUFWORD or automatically, as part of your nightly
  423.     EVENT process.
  424.  
  425.     As a nightly EVENT, SHUFWORD checks to see if the number of players,
  426.     as defined in the configuration file, have completed all words, in which
  427.     case it will automatically supply a new set of words and reset/update
  428.     the appropriate files. The following is an EXAMPLE of what needs to be
  429.     placed in your EVENT file :
  430.  
  431.  
  432.            CD\BBS\DOORS\SHUFFLE        Location of SHUFFLE files
  433.            SHUFWORD SHUFFLE.CFG /E     EXE filename and config filename
  434.            CD\BBS
  435.            BOARD
  436.  
  437.  
  438.  
  439.  
  440.  
  441.                                ADOPT-A-DOOR
  442.                                ____________
  443.  
  444.  
  445.     Having been a Sysop for a number of years, I have had my share of problems
  446.     and frustrations getting financial support for my board's upkeep. A fellow
  447.     Sysop left a message on my board, not long ago, about a concept that was
  448.     being used by several boards around the country.
  449.  
  450.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  451.     would be the same as sending in a donation, only this way it is earmarked
  452.     for registering a particular door. In a way, the user feels he/she is
  453.     "getting something in return". As a Door author I have decided to build
  454.     this concept into each of my Door programs. The concept replaces the
  455.     usual message "tell the Sysop to register this Door" we find in most
  456.     doors.
  457.  
  458.     If the Door is unregisterd then a message appears on the opening screen
  459.     to that effect. After finishing or suspending a game, a message screen
  460.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  461.     caller to contact the Sysop to find out if there is any further details
  462.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  463.     time, etc to callers that ADOPT-A-DOOR.
  464.  
  465.     If the Door has been registered, either by the Sysop or other callers,
  466.     the names of those contributors will be displayed in the closing screen.
  467.  
  468.     NOTE: If you want to display the names of the callers that contributed
  469.           to registering the Door, you must create an ASCII file called
  470.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  471.           the name(s) of the contributors (one on each line, maximum of 5
  472.           entries, each a maximum of 30 characters long). This file must be
  473.           saved, in ASCII format, and placed in the Door directory.
  474.  
  475.  
  476.  
  477.                               LEGALITIES
  478.                               __________
  479.  
  480.  
  481.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  482.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  483.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  484.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  485.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  486.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  487.       OR BREACH OF ANY WARRANTY.
  488.  
  489.  
  490.  
  491.  
  492.  
  493.                              DISTRIBUTION
  494.                              ____________
  495.  
  496.    You may make this file available for downloading from your BBS or you may
  497.    upload it to any BBS of your choice, provided that you do not make any
  498.    changes to the contents of the archive (ZIP file). The archive and its
  499.    individual contents may not be used by any service that charges any money
  500.    whatsoever, without the written permission of the author.
  501.  
  502.  
  503.  
  504.  
  505.  
  506.                              REGISTRATION
  507.                              ____________
  508.  
  509.    Registration and the subsequent insertion of the registration number into
  510.    your configuation file, allows for the display of your BBS name on the
  511.    opening and closing screen as well as the reduction of a delay built into
  512.    the opening screen display along with the ability to change certain values
  513.    in the configuration file.
  514.  
  515.    To register your copy of WORD SHUFFLE, please fill out the registration
  516.    form (REGISTER.FRM) and mail it along with the registration fee to
  517.    the name and address on the form or supply a self-addressed stamped
  518.    envelope for registration number by return mail.
  519.  
  520.    Once a door is registered, any changes to registration information (Sysop
  521.    name or BBS Name) will require the doors to be re-registered. Download or
  522.    File Request a file named CHANGE.FRM from our BBS, complete the form and
  523.    follow ALL instructions in the document!
  524.  
  525.    Registration fees are subject to change at any time. The most current
  526.    registration form is always available on our BBS. You may download or
  527.    File Request REGISTER.FRM at any time.
  528.  
  529.    Be sure to use the proper upper/lower case when filling in your name and
  530.    BBS name, as they MUST match the way you entered them in the configuration
  531.    file.             ^^^^
  532.  
  533.    Based upon information supplied on the registration form, I will pre-
  534.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  535.    up your registration number.
  536.  
  537.  
  538.  
  539.                                  MISC
  540.                                  ____
  541.  
  542.    The latest version of WORD SHUFFLLE and other fine SUNRISE DOOR programs
  543.    are always available for download from SUNRISE-80 BBS.
  544.  
  545.    Remember, should you have any problems, questions or suggestions, be sure
  546.    to drop me a message on either of the aforementioned BBS'.  I am now a
  547.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS,
  548.    PCBhints RIME conferences.
  549.